Use ruff.toml format in README #10393
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zanieb
reviewed
Mar 13, 2024
README.md
Outdated
| The remaining configuration options can be provided through a catch-all `--config` argument: | ||
|
|
||
| ```shell | ||
| ruff check path/to/code/ --config "lint.per-file-ignores = {'some_file.py' = ['F841']}" |
There was a problem hiding this comment.
I don't love path/to/code/ here it seems like a bad example as a corollary for file discovery options.
I know it's copied from above but maybe a good time to improve
charliermarsh
force-pushed
the
charlie/c
branch
from
7fe8df8
to
f587597
Compare
charliermarsh
force-pushed
the
charlie/c
branch
from
f587597
to
0d5f128
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
See feedback in #4725 (comment).
In the docs, we use a tabbed interface for express
ruff.tomlvs.pyproject.toml. Here, it might be clearer to default toruff.toml, since it's more obviously notpyproject.toml. But either way, this PR attempts to clarify that there's a difference.